DOCSP-47058: Shift TOC #251

Name	Link
🔨 Latest commit	`6b0af60`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-php-library/deploys/682e072a4c85850008250557
😎 Deploy Preview	https://deploy-preview-251--docs-php-library.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

rustagir

looks super clean but requesting changes just to be able to have another look before you merge!

rustagir · 2025-05-21T13:35:44Z

config/redirects

+
+# comprehensive coverage redirects
+[v2.x-*]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/


Q: are we going to backport the TOC changes as we've done with the other languages? in that case, should you redirect all versions?

If that's what we've done for the others then yes I'll backport to all for PHP too, fixed!

rustagir · 2025-05-21T13:36:36Z

config/redirects

S: consider redirecting these to the CRUD landing page instead

rustagir · 2025-05-21T13:38:06Z

config/redirects

+[v2.x-*]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/
+[v2.x-*]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/
+[v2.x-*]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/


S: consider redirecting to the monitoring-logging.txt landing page

rustagir · 2025-05-21T13:39:13Z

source/crud.txt

+   Operations with Builders </crud/builders>
+
+CRUD (Create, Read, Update, Delete) operations enable you to work with
+data stored in MongoDB.


S: add a sentence introducing the list

"Visit the following guides to learn more about performing CRUD operations on the data in your MongoDB collections... etc"

rustagir · 2025-05-21T13:39:34Z

source/crud/bulk-write.txt

@@ -68,7 +68,7 @@ specify the write operations:
 .. tip::

    For more information about delete, insert, replace, and update
-    operations, see the :ref:`Write operation guides <php-write>`.
+    operations, see the :ref:`CRUD <php-crud-operations>` section.


Suggested change

operations, see the :ref:`CRUD <php-crud-operations>` section.

operations, see the :ref:`php-crud-operations` guides.

source/crud/query.txt

source/crud/transaction.txt

rustagir · 2025-05-21T13:41:33Z

source/get-started.txt

S: nit - dont need <> brackets when importing the ref title directly

Suggested change

- Learn how to configure your MongoDB connection in the :ref:`<php-connect>` section.

- Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section.

- Learn how to configure your MongoDB connection in the :ref:`php-connect` section.

- Learn how to perform read and write operations in the :ref:`php-crud-operations` section.

rustagir · 2025-05-21T13:42:27Z

source/issues-and-help.txt

+
+.. meta::
+   :keywords: php, troubleshooting, feedback
+   :description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute.


Suggested change

:description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute.

:description: Find support for the PHP library, report bugs or feature requests, and learn how to contribute.

rustagir · 2025-05-21T13:42:47Z

source/issues-and-help.txt

+
+.. note::
+
+   Bug reports in the PHP Jira project are publicly viewable.


Suggested change

Bug reports in the PHP Jira project are publicly viewable.

Bug reports in the PHPLIB Jira project are publicly viewable.

rustagir

lgtm!

rustagir · 2025-05-21T15:16:45Z

snooty.toml

@@ -21,14 +21,12 @@ toc_landing_pages = [
    "/reference/class/MongoDBModelDatabaseInfo",
    "/reference/class/MongoDBModelIndexInfo",
    "/connect",


S: add /connect/connection-options/

rustagir · 2025-05-21T15:19:27Z

source/index.txt

+Atlas Vector Search
+-------------------
+
+Learn how to run Atlas Vector Search queries in the :ref:`<php-vector-search>` section.

 Optimize Queries with Indexes


S: this item is out of order

rustagir · 2025-05-21T15:21:06Z

source/references.txt

+   Release Notes </references/release-notes>
+   Compatibility </references/compatibility>
+   Upgrade Guides </references/upgrade>
+


S: add short sentence introducing sub pages

* Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]>

* Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512)

* Add redirects workflow * DOCSP-47058: Shift TOC (mongodb#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (mongodb#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (mongodb#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (mongodb#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (mongodb#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (mongodb#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (mongodb#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (mongodb#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (mongodb#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (mongodb#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (mongodb#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (mongodb#274) * DOCSP-50753: agg tutorial link (mongodb#275) * DOCSP-47063: Logging (mongodb#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (mongodb#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (mongodb#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (mongodb#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (mongodb#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (mongodb#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512) (cherry picked from commit f11a732)

* PHP Comprehensive Coverage (#282) * Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512) (cherry picked from commit f11a732) * build errors * remove isView --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]>

DOCSP-47058: Shift TOC

b09530d

norareidy added 5 commits May 20, 2025 15:53

edits

f3833c2

issues and help, edits

5f9ae2e

fix errors

4893502

redirects

72bd19a

landing

a253e74

rustagir suggested changes May 21, 2025

View reviewed changes

RR feedback

44ad1b8

norareidy requested a review from rustagir May 21, 2025 14:59

rustagir approved these changes May 21, 2025

View reviewed changes

RR feedback 2

6b0af60

norareidy merged commit c5f7fd8 into mongodb:comp-cov May 21, 2025
7 checks passed

norareidy deleted the DOCSP-47058-toc branch May 21, 2025 17:33

norareidy mentioned this pull request Jul 9, 2025

PHP Comprehensive Coverage - v1.x backport (#282) #283

Merged

6 tasks


		# comprehensive coverage redirects
		[v2.x-*]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/

	operations, see the :ref:`CRUD <php-crud-operations>` section.
	operations, see the :ref:`php-crud-operations` guides.

-- Learn how to configure your MongoDB connection in the :ref:`<php-connect>` section.
-- Learn how to perform read and write operations in the :ref:`<php-crud-operations>` section.
+- Learn how to configure your MongoDB connection in the :ref:`php-connect` section.
+- Learn how to perform read and write operations in the :ref:`php-crud-operations` section.

	:description: Find support for the {+library-short+, report bugs or feature requests, and learn how to contribute.
	:description: Find support for the PHP library, report bugs or feature requests, and learn how to contribute.


		.. note::

		Bug reports in the PHP Jira project are publicly viewable.

	Bug reports in the PHP Jira project are publicly viewable.
	Bug reports in the PHPLIB Jira project are publicly viewable.

DOCSP-47058: Shift TOC #251

DOCSP-47058: Shift TOC #251

Uh oh!

Conversation

norareidy commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlify bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-php-library ready!

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

norareidy commented May 20, 2025 •

edited

Loading

netlify bot commented May 20, 2025 •

edited

Loading